Package: github.com/K-Phoen/grabana/variable/query

package query Import Path github.com/K-Phoen/grabana/variable/query (on go.dev) Dependency Relation imports one package, and imported by one package

Involved Source Files query.go

Package-Level Type Names (total 4)

/* sort by: alphabet | popularity */

type Option (func) Option represents an option that can be used to configure a query. As Outputs Of (at least 12) func AllValue(value string) Option func DataSource(source string) Option func DefaultAll() Option func Hide() Option func HideLabel() Option func IncludeAll() Option func Label(label string) Option func Multiple() Option func Refresh(refresh RefreshInterval) Option func Regex(regex string) Option func Request(request string) Option func Sort(order SortOrder) Option As Inputs Of (at least 2) func New(name string, options ...Option) *Query func github.com/K-Phoen/grabana/dashboard.VariableAsQuery(name string, options ...Option) dashboard.Option

type Query (struct) Query represents a "query" templated variable. Fields (only one) Builder sdk.TemplateVar As Outputs Of (at least one exported) func New(name string, options ...Option) *Query

type RefreshInterval int (basic type) RefreshInterval represents the interval at which the results of a query will be refreshed. As Inputs Of (at least one exported) func Refresh(refresh RefreshInterval) Option

type SortOrder int (basic type) SortOrder represents the ordering method applied to values. As Inputs Of (at least one exported) func Sort(order SortOrder) Option As Types Of (total 7) const AlphabeticalAsc const AlphabeticalDesc const AlphabeticalNoCaseAsc const AlphabeticalNoCaseDesc const None const NumericalAsc const NumericalDesc

Package-Level Functions (total 13)

func AllValue(value string) Option AllValue defines a custom "all" value.

func DataSource(source string) Option DataSource sets the data source to be used by the query.

func DefaultAll() Option DefaultAll selects "All" values by default.

func Hide() Option Hide ensures that the variable will not be displayed.

func HideLabel() Option HideLabel ensures that this variable's label will not be displayed.

func IncludeAll() Option IncludeAll adds an option to allow all values to be selected.

func Label(label string) Option Label sets the label of the variable.

func Multiple() Option Multiple allows several values to be selected.

func New(name string, options ...Option) *Query New creates a new "query" templated variable.

func Refresh(refresh RefreshInterval) Option Refresh defines the interval in which the values will be refreshed.

func Regex(regex string) Option Regex defines a filter allowing to filter the values returned by the request/query.

func Request(request string) Option Request defines the query to be executed.

func Sort(order SortOrder) Option Sort defines the order in which the values will be sorted.

Package-Level Constants (total 11)

const All = "$__all"

const AlphabeticalAsc SortOrder = 1 AlphabeticalAsc will sort the results by ascending alphabetical order.

const AlphabeticalDesc SortOrder = 2 AlphabeticalDesc will sort the results by descending alphabetical order.

const AlphabeticalNoCaseAsc SortOrder = 5 AlphabeticalNoCaseAsc will sort the results by ascending alphabetical order, case-insensitive.

const AlphabeticalNoCaseDesc SortOrder = 6 AlphabeticalNoCaseDesc will sort the results by descending alphabetical order, case-insensitive.

const DashboardLoad = 1 DashboardLoad will refresh the results every time the dashboard is loaded.

const Never = 0 Never will prevent the results from being refreshed.

const None SortOrder = 0 None will preserve the results ordering as returned by the query.

const NumericalAsc SortOrder = 3 NumericalAsc will sort the results by ascending numerical order.

const NumericalDesc SortOrder = 4 NumericalDesc will sort the results by descending numerical order.

const TimeChange = 2 TimeChange will refresh the results every time the time interval changes.